/*
 * Copyright (c) 2011, Michael Bedward
 * 
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this 
 * list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the documentation 
 * and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 */

package com.mousebender.gridfacade;

import com.mousebender.gridfacade.analytical.AnalyticalFunction;
import com.mousebender.gridfacade.analytical.AnalyticalGridView;
import com.mousebender.gridfacade.vector.PointGridView;
import com.mousebender.gridfacade.vector.PolygonGridView;
import com.vividsolutions.jts.geom.Geometry;

import org.geotools.data.simple.SimpleFeatureCollection;
import org.geotools.geometry.jts.Geometries;
import org.geotools.geometry.jts.ReferencedEnvelope;

/**
 *
 * @author michael
 */
public class GridViews {

    /**
     * Creates a new {@code GridView} of the given feature collection.
     * 
     * @param <V> type of the feature attribute used to get grid values
     * 
     * @param featureCollection a feature collection with vector geometry (point, line 
     *     or polygon)
     * 
     * @param attributeName the name of the feature attribute to use for grid values;
     *     must be numeric
     * 
     * @param bounds bounds of the grid view
     * 
     * @param cellXDim grid cell X dimension
     * 
     * @param cellYDim grid cell Y dimension
     * 
     * @param outsideValue value to return when the grid is queried at locations outside
     *     any feature
     * 
     * @return a new grid view
     */
    public static <V extends Number> GridView<V> create(SimpleFeatureCollection featureCollection, 
            String attributeName,
            ReferencedEnvelope bounds, 
            double cellXDim, 
            double cellYDim, 
            V outsideValue) {
        
        Class<?> binding = featureCollection.getSchema().
                getGeometryDescriptor().getType().getBinding();
        
        switch (Geometries.getForBinding((Class<? extends Geometry>) binding)) {
            case POLYGON:
            case MULTIPOLYGON:
                return new PolygonGridView<V>(featureCollection,
                        attributeName,
                        bounds,
                        cellXDim,
                        cellYDim,
                        outsideValue);
                
            case POINT:
            case MULTIPOINT:
                return new PointGridView<V>(featureCollection,
                        attributeName,
                        bounds,
                        cellXDim,
                        cellYDim,
                        outsideValue);
                
            default:
                throw new UnsupportedOperationException(
                        binding.getName() + "is not presently supported");
        }
    }

    public static <V extends Number> GridView<V> create(AnalyticalFunction<V> fn, 
            ReferencedEnvelope bounds, 
            double cellXDim, 
            double cellYDim, 
            V outsideValue) {
        
        return new AnalyticalGridView<V>(fn, bounds, cellXDim, cellYDim, outsideValue);
    }

}
